Skip to content
This repository has been archived by the owner on Mar 17, 2021. It is now read-only.

Add enum values of SW360 data model correctly #582

Conversation

neubs-bsi
Copy link
Contributor

@neubs-bsi neubs-bsi commented Sep 2, 2020

Issue: #580

In the sw360 data model the documentation of the clearing states
are now added and the enum values are case corrected to be
upper case in the change status key.

Request Reviewer

You can add desired reviewers here with an @mention.
@sschuberth

Type of Change

Mention one of the following:
bug fix | new feature | improvements | documentation update | CI | Other

Type of change: documentation

How Has This Been Tested?

If you have added any changes that require additional tests, or changes in tests, you should implement them and describe them here.
All test that passed before your contribution should pass after it as well.

Checklist

Must:

  • All related issues are referenced in commit messages

Optional: (delete if not applicable)

  • I have provided tests for the changes (if there are changes that need additional tests)
  • I have updated the documentation accordingly to my changes

@@ -64,8 +64,10 @@ In the following section there is an outline what data of SW360 ${docNameCap} ma
| Release Tag Url | This is a link to the OSS repos tag of the release used stored as external id with key `orig_repo`. |
| Software Heritage ID | A release ID in software heritage in the format "swh:1:rel:*", stored as external id with key `swh`. |
| Copyrights | Copyrights of the release, given in a String. Individual copyrights are separated by line. Stored in the additional data section with key `copyrights` |
| Change Status | An enumeration with values `changed` or `as-is` stored as additional data with key `change_status`. A changed component release should be stored as own release with an appendix to the original version, e.g. `1.2.3_modified_xyz`. Currently the implementation can only handle `as-is` components. |
| Change Status | An enumeration with values `CHANGED` or `AS_IS` stored as additional data with key `change_status`. A changed component release should be stored as own release with an appendix to the original version, e.g. `1.2.3_modified_xyz`. Currently the implementation can only handle `AS_IS` components. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit message: Please make the reference to the issue go last (between body and footer) and use one of the auto-closing keywords.

| Clearing Report | A file with curated data and the approval state. If the status of this attachment is `Accepted`, the Clearing State of the component release is `Approved`. Typically uploaded by compliance office tooling. |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit message: Please make the reference to the issue go last (between body and footer) and use one of the auto-closing keywords.


**Note**:
All string fields in this data model have a limit of 2147483647 - 1 in length, since this is the frame size of the binary protocol used with thrift.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing final new-line.

@neubs-bsi neubs-bsi force-pushed the neubs-bsi/doc/sw360_model_case_sensitiv branch 2 times, most recently from 222c0f4 to 3b79849 Compare September 2, 2020 12:16
In the sw360 data model the documentation of the clearing states
are now added and the enum values are case corrected to be
upper case in the change status key.

Relates to eclipse-archived#580.

Signed-off-by: Stephanie Neubauer <[email protected]>
@neubs-bsi neubs-bsi force-pushed the neubs-bsi/doc/sw360_model_case_sensitiv branch from 3b79849 to 95521f2 Compare September 2, 2020 13:18
@sonarqubecloud
Copy link

sonarqubecloud bot commented Sep 2, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

warning The version of Java (1.8.0_265) you have used to run this analysis is deprecated and we will stop accepting it from October 2020. Please update to at least Java 11.
Read more here

@neubs-bsi neubs-bsi merged commit f19d52d into eclipse-archived:master Sep 2, 2020
@neubs-bsi neubs-bsi deleted the neubs-bsi/doc/sw360_model_case_sensitiv branch October 7, 2020 08:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants